Skip to main content
POST

Recipes

1

1. Use a contacts parameter to set an array of contact hashes

2

2. Set a name of the contact

Note that a name is limited to a number of signs. Min: 1. Max: 25.
3

3. Set a phone of the contact

Note that a phone is limited to a number of signs. Min: 10. Max: 15.
4

4. Specify if you want to delete a contact

Set a destroy parameter as 1 to delete a contact.
5

5. Set a device identifier

Set a udid parameter to specify a user’s device. If specified, a contact will be deleted for a specified device only.
6

6. As a result, the API returns a response specifying that a contact was deleted.

1

1. Use a contacts parameter to set an array of contact hashes

2

2. Set a name and phone of the contact as separate arrays

Note that it’s incorrect to set a name separately from a phone.
3

3. Set a name as an empty string

Note that a name is limited to a number of signs. Min: 1. Max: 255.
4

4. Set an incorrect phone length

Note that a phone is limited to a number of signs. Min: 10. Max: 15.
5

5. As a result, the API returns a 200 status response specifying that the data were set incorreclty.

1

1. Use a contacts parameter to set an array of contact hashes

2

2. Set a name of a contact

Note that a name is limited to a number of signs. Min: 1. Max: 255.
3

3. Set a phone of a contact

Note that a phone is limited to a number of signs. Min: 10. Max: 15.
4

4. Specify if you want to replace existing contacts with the one specified

Set a force as 1 to replace the contacts.
5

5. Set a device identifier

Set a udid parameter to specify a user’s device. If specified, contacts will be replaced for a specified device only.
6

6. As a result, the API returns a responce specifying that 1 contact was created and 3 deleted.

1

1. Use a contacts parameter to set an array of contact hashes

2

2. Set a name of the contact

Use a name parameter to set the name of the contact.
3

3. Set a phone of the contact

Use a phone parameter to set a phone of the contact.
4

4. As a result, the API returns a 200 status response specifying that the contacts were uploaded.

This API allows you to do following things:
  • Upload new address book.
  • Replace old address book with a new one.
  • Add/delete individual contacts.
  • Update existing contacts.

Body Parameters

array
required
Contains an array of contact objects. Each contact can contain 3 keys - phone, name, and destroy.
integer
Defines force rewrite mode. Set force=1 to apply, then all previous contacts for the device context will be replaced by new ones.
string
User’s device identifier. If specified, all operations will be in this context. Max. length is 64 symbols. If the device identifier is not specified, it means that a user has one global address book across all their devices.

Headers

string
required
A user session token. See Authentication page to learn more about the session token.

Responses

A successful response
integer
integer
integer