Path parameters

• transactionId string(uuid) Required

  The id of the transaction.

Responses

• 200

  OK

• 201 application/json

  Request succeeded.

  Hide response attributes Show response attributes object

  • id string(uuid)

    The unique id.

  • createdTimestamp string(date-time) | null

    The date and time of creation in UTC time.

  • modifiedTimestamp string(date-time) | null

    The date and time last modification in UTC time.

  • contactTypeId string(uuid) Required

    The unique id of the contact type.

  • endCode string Required

    The end or side of the transaction with which the contact is associated.

    Values are B or S.

  • prefix string | null

    The prefix for the contact, such as Mr., Mrs., Ms., Dr., etc.

  • firstName string Required

    The first name of the contact.

  • lastName string Required

    The last name of the contact.

  • companyName string | null

    The name of the company.

  • addressLine1 string | null

    The full street address for the company of the contact.

  • addressLine2 string | null

    The second line of the street address, if applicable (e.g., suite number).

  • addressCity string | null

    The city of the contact's address.

  • addressPostalCode string | null

    The postal code of the contact's address. This will be unformatted.

  • addressProvinceCode string | null

    The two character code for the province or state.

  • addressCountryCode string | null

    The two character code for the country of the contact's address.

  • phoneNumberMain string | null

    The main phone number for the contact. This will be unformatted.

  • phoneNumberBusiness string | null

    The phone number of the business for the contact. This will be unformatted.

  • phoneNumberMobile string | null

    The mobile or cell phone number for the contact. This will be unformatted.

  • faxNumberMain string | null

    The main fax number for the contact. This will be unformatted.

  • emailAddressMain string | null

    The main email address of the contact.

  • emailAddressWork string | null

    The main email address of the contact.

  • contactType object

    A read only representation of a contact type.

    Additional properties are NOT allowed.

    Hide contactType attributes Show contactType attributes object

    • name string | null

      The name of the contact type.

    • code string | null

      The unique code for the contact type.

• 400 application/json

  Invalid request. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 401 application/json

  Unauthorized. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 403 application/json

  Permission denied. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 404 application/json

  Not found. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 409 application/json

  Conflict. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 422 application/json

  Validation failed. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.