COconductor-is

Create an end-user

Changed on

Creates an end-user.

post/end-users

Request

Request body

companyNamestring required

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

sourceIdstring 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.

emailstring required

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

Example request

{
  "companyName": "Acme Inc.",
  "sourceId": "12345678-abcd-abcd-example-1234567890ab",
  "email": "alice@acme.com"
}

Response

Returns the end-user object after successful end-user creation.

idstring 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'end_user' required

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

createdAtstring required

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

companyNamestring required

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

sourceIdstring required

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

emailstring required

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

Example response

{
  "id": "end_usr_1234567abcdefg",
  "objectType": "end_user",
  "createdAt": "2024-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": "2024-01-01T12:34:56.789Z",
      "lastRequestAt": "2024-01-01T12:34:56.789Z",
      "lastSuccessfulRequestAt": "2024-01-01T12:34:56.789Z"
    }
  ]
}

Changes

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property integrationConnections/items/lastRequestAt list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property integrationConnections/items/lastSuccessfulRequestAt list-of-types was widened by adding types null to media type application/json of response 200

  • 8e0b7df2044dRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      removed the pattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ from the request property

    • info

      response property integrationConnections/items/lastRequestAt list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property integrationConnections/items/lastSuccessfulRequestAt list-of-types was narrowed by removing types null from media type application/json of response 200