Skip to main content
POST
/
v1
/
members
/
jobs
cURL
curl --request POST \
  --url https://api.onsi.com/v1/members/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "actions": [
    {
      "email": "jane-smith@onsi.com",
      "firstName": "John",
      "lastName": "Smith",
      "tier": "Gold",
      "type": "Add",
      "phone": "+447123456789",
      "workerId": "ID_123",
      "accountDetails": {
        "accountHolder": "John Smith",
        "sortCode": "123456",
        "accountNumber": "12345678"
      },
      "enablePayroll": true,
      "dob": "1990-01-01",
      "gender": "Female"
    }
  ]
}
'
{
  "jobId": "maj_cltd2zp7100096tmbamb9c46o"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onsi.com/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new job, which runs asynchronously and returns a job ID. The job ID can be used to check the status of the job. The job contains an array of operations, of the same format as the single changes APIs:
  • Add - Invites a new member to your Onsi programme.
  • Replace - Replaces the member’s data with new information. An inactive member will be re-added to Onsi.
  • Update - Updates the member’s data with new information. Does not re-add inactive members.
  • Remove - Removes the member from your Onsi programme.

​
Unsetting Bank Details

For Replace and Update operations, you can remove a member’s bank details by setting accountDetails to null.

​
Relevant Error Codes

If there are issues with any of the operations, the API will return a 400 status code with the following error codes:
If there are issues, Onsi will not process any of the operations in your request, and will not create a job. You will need to fix the issues and send a subsequent request.

Authorizations

​
x-api-key
string
header
required

Headers

​
x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json

Body

​
actions
(Add · object | Replace · object | Update · object | Offboard · object)[]
required
Minimum array length: 1

Add a new member

Response

202 - application/json

202

​
jobId
string
required
Example:

"maj_cltd2zp7100096tmbamb9c46o"