ADadfin
Customers

Create a customer

Changed on
post/customers

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/customers
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Request body

namestring

The full name of the customer.

trackingItemIdsstring[]

The list of tracking item catalogue IDs associated with the customer.

officeIdstring uuid

The office ID associated with the customer.

collectionAgentIdstring uuid

The collection agent ID to associate with the customer.

Example request

{
  "name": "John Doe",
  "people": [
    {
      "name": "Jane Smith",
      "email": "jane.smith@example.com"
    }
  ],
  "addresses": [
    {
      "line1": "2 Catherine Pl",
      "city": "London",
      "state": "NY",
      "postCode": "SW1E 6HF"
    }
  ]
}

Response

The request has succeeded and has resulted in one customer being updated.

idstring

The Adfin id of the customer.

externalIdstring

The id of the customer from the platform that is integrating with Adfin.

namestring

The full name of the customer.

creationTimestring date-time

The time the customer was created.

lastUpdatedTimestring date-time

The last time when the customer was updated.

timezonestring

The timezone of the customer.

tagsstring[]

The tag ids associated with the customer.

status'ACTIVE' | 'ARCHIVED'

The status of the customer (ACTIVE, ARCHIVED)

statusReasonCode'MERGED' | 'ARCHIVED_MANUALLY'

The reason as a predefined code for why the customer is in a certain status

collectionAgentIdstring uuid

The collection agent ID associated with the customer.

Changes

  • 5eb8e7e1d53cRevision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

  • 1a2e874091e2Revision changes
    • info

      added the optional property / to the response with the status