post
https://api.octopush.com/v1/public/contact/create
Encoding : UTF-8
Authentication
Your "api-key" and "api-login" identifiers must be added in the headers.
Definition
This web service allows you to add some contacts to your account, and attach them to a contact list, or a tag.
Special parameters
| Name | Type | Description |
|---|---|---|
| list_name | string | This is the value representing to list name you want to create. |
| list_names | array | This is the values representing to list names you want to create. |
| un_list | boolean | This value is "true" when you want to detach all lists associated with contacts. |
| tag_name | string | This is the value representing to tag name you want to create. |
| tag_names | array | This is the values representing to tag names you want to create. |
| un_tag | boolean | This value is "true" when you want to detach all tags associated with contacts. |
| contacts | array | Array of contacts { 'phone_number': '', 'first_name': '', 'last_name': '', 'param1': '', 'param2': '', 'param3': '', 'param4': '', 'param5': ''} |
| auto_delete_optout_contacts | boolean | This value is "true" when you want to send with ignore optout contacts. |
| do_not_overwrite | boolean | This value is "true" when you want to overwrite existing records during insertion |
How Our API Deals With Incorrect Data
The API we provide will try to interpret your request as best it can. If a parameter has the wrong value, we will try to understand it anyway. If the parameter has the wrong type, we will try to format it as best we can. Thus, we have determined default values, which are indicated in our documentation. If a parameter could not be recognized or "fixed", we will ignore it, but your request will be sent.
If one of your parameters does not have the right value, or does not have the right type, we will try to:
- "cast" (convert) it so that it can be understood.
- format it (delete prohibited characters for example)
Bad request.
Unauthorized.
Forbidden to view.