AIairship
Contacts

Contact disassociation

Changed on

Disassociates channel from a contact with the option of also opting out. You can identify a channel by MSISDN, email address, or channel ID.

post/api/contacts/disassociate/{contact_id}

Request

Path parameters

contact_idstring uuid required

The contact ID to disassociate from a channel.

Request body

channel_idstring uuid

The channel ID to disassociate from the contact.

channel_type'sms' | 'email' | 'ios' | 'android' | 'amazon' | 'web' | 'open' required

The type of channel.

email_addressstring

The email address to disassociate from the contact.

msisdnstring

The mobile phone number to disassociate from the contact. Must be numeric characters only, without leading zeros. 15 digits maximum.

opt_outboolean

Optional. True if the channel is to be opted out; otherwise false.

senderstring

A long or short code the app is configured to send from. For example, 12345.

Example request

{
  "channel_id": "{{channel_id}}"
}

Response

The request was accepted.

channel_idstring uuid

Identifies the existing unique channel ID.

contactstring uuid

Identifies the existing unique contact ID.

okboolean

Success.

Example response

{
  "channel_id": "ef625038-70a3-41f1-826f-57bc11dd625a",
  "contact": "ef625038-70a3-41f1-826f-57bc11dd625a"
}

Changes

  • e2bd980cb50bRevision changes
    • info

      the endpoint scheme security oauth2Token was added to the API

    • info

      the endpoint scheme security contactJWTToken was removed from the API

    • info

      added the new amazon enum value to the request property

    • info

      added the new android enum value to the request property

    • info

      added the new ios enum value to the request property

    • info

      added the new open enum value to the request property

    • info

      added the new web enum value to the request property

  • 43eb86d7e2d0Revision changes
    • info

      endpoint added

    This list may be incomplete.