POST
/
end-users
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  const endUser = await client.endUsers.create({
    companyName: 'Acme Inc.',
    email: 'alice@acme.com',
    sourceId: '12345678-abcd-abcd-example-1234567890ab',
  });

  console.log(endUser.id);
}

main();
{
  "id": "end_usr_1234567abcdefg",
  "objectType": "end_user",
  "createdAt": "2021-01-01T12:34:56.789Z",
  "companyName": "Acme Inc.",
  "sourceId": "12345678-abcd-abcd-example-1234567890ab",
  "email": "bob@acme.com",
  "integrationConnections": [
    {
      "id": "int_conn_1234567abcdefg",
      "objectType": "integration_connection",
      "createdAt": "2021-01-01T12:34:56.789Z",
      "integrationSlug": "quickbooks_desktop",
      "lastRequestAt": "2021-01-01T12:34:56.789Z",
      "lastSuccessfulRequestAt": "2021-01-01T12:34:56.789Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Body

application/json
​
companyName
string
required

The end-user's company name that will be shown elsewhere in Conductor.

​
sourceId
string
required

The end-user's unique identifier from your system. Maps users between your database and Conductor. Must be unique for each user. If you have only one user, you may use any string value.

​
email
string
required

The end-user's email address for identification purposes. Setting this field will not cause any emails to be sent.

Response

200 - application/json
Returns the end-user object after successful end-user creation.
​
id
string
required

The unique identifier for this end-user. You must save this value to your database because it is how you identify which of your users to receive your API requests.

​
objectType
string
required

The type of object. This value is always "end_user".

Allowed value: "end_user"
​
createdAt
string
required

The date and time when this end-user record was created.

​
companyName
string
required

The end-user's company name that will be shown elsewhere in Conductor.

​
sourceId
string
required

The end-user's unique identifier from your system. Maps users between your database and Conductor.

​
email
string
required

The end-user's email address for identification purposes.

​
integrationConnections
object[]
required

The end-user's integration connections.

The End-User objectRetrieve an end-user