Search for Contact

GET /contacts

Parameters

  • api_key string
  • account string  optional - Account's email in which to save the contact. Default is the original account.
  • mobile_number string optional - Mobile number with country code (eg. '+19876543210'). Don't pass this parameter if you want to search for all of your contacts.

Response

{
    first_name: "John",
    last_name: "Doe",
    mobile_number: "+19876543210"
}
  • first_name string
  • last_name string
  • mobile_number string

_______________________________
 

Create a Contact

POST /contacts/create 

Parameters

  • api_key string 
  • account string  optional - Account's email in which to save the contact. Default is the original account.
  • first_name string 
  • last_name string 
  • mobile_number string - Contact's mobile number with country code (eg. '+19876543210').
  • account_number string  optional - Account's mobile number with country code (eg. '+19876543210') from which this contact should receive messages from.
  • group string optional - Group in which to save the contact.

Response

{
    first_name: "John",
    last_name: "Doe",
    mobile_number: "+19876543210"
}
  • first_name string 
  • last_name string 
  • mobile_number string - Mobile number with country code (eg. '+19876543210').

_______________________________
 

Delete a Contact

POST /contacts/delete 

Parameters

  • api_key string  
  • account string   optional - Account's email from which to delete the contact. Default is the original account.
  • mobile_number string  - Contact's mobile number with country code (eg. '+19876543210').

Response

{
    first_name: "John",
    last_name: "Doe",
    mobile_number: "+19876543210"
}
  • first_name string  
  • last_name string 
  • mobile_number string  - Mobile number with country code (eg. '+19876543210').

_______________________________
 

Opt Out a Contact

POST /contacts/opt_out 

Parameters

  • api_key string  
  • mobile_number string   - Contact's mobile number with country code (eg. '+19876543210').

A contact can only opt back in by replying START

Did this answer your question?