Contacts resources overview

Resources Overview##

OPERATION

PATH

DESCRIPTION

POST

/contacts/my

Creates or updates a new contact. If the contact with the given mobile number already exists, the contact will be updated, otherwise a new contact will be created.

DELETE

/contacts/my

Deletes all the specified contacts from the account.

GET

/contacts/my

Retrieves all the contacts of this account and sub-accounts.

GET

/contacts/my/{id}

Retrieves details for the contact with the given id.

PUT

/contacts/my/{id}

Updates the contact with the given id.

DELETE

/contacts/my/{id}

Deletes the contact with the given id.

HEAD

/contacts/my/mobile

Determines whether a contact with the provided mobile number exists.

POST

/contacts/my/blacklist/{service}

Adds contacts to the opt-out contacts of the given service.

GET

/contacts/my/blacklist/{service}

Returns all the opt-outed contacts for the given service.

DELETE

/contacts/my/blacklist/{service}/groups

Removes contacts by groups from the opt-outed contacts of the given service.

GET

/contacts/labels/my

Returns all the contact labels that this account has defined (both default and custom).

POST

/contacts/labels/my

Creates contact labels for this account.

GET

/groups/my

Creates a new group.

DELETE

/groups/my

Deletes an array of groups.

POST

/groups/my/merge

Creates a new group from the merge operation applied on the provided groups.

POST

/groups/my/difference

Creates a new group from the difference operation applied on the provided groups.

GET

/groups/my/{name}/contacts

Returns all contacts of the provided "tag".

DELETE

/groups/my/{name}/contacts

Deletes the contacts that match the provided ids from the specified group.

POST

/groups/my/{name}/contacts

Adds existing contacts to a group.

DELETE

/contacts/my/blacklist/{service}

Removes contacts from the opt-outed contacts of the given service.


What’s Next