Contacts & Lists

Update Contact

Edit a contact that exists on a list Used for adding new or updated custom data to a contact on a list.

post/edit-list-member.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

list_idinteger required

Numeric ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. It can be found in the URL and displayed on a destination list page in your account. A list ID can also be created using the add-list call.

msisdnstring required

Mobile number of contact being updated. Invalid numbers will be ignored. Number must be defined in E.164 international format.

first_namestring

First name of contact being added.

last_namestring

Last name of contact being added.

field_nstring

Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. n is an integer between 1 and 10.

Example request

{
  "list_id": 12345,
  "msisdn": "61478038915"
}

Response

Successful response

list_idinteger

Numeric ID of the list that contact was added to.

msisdnstring

Mobile number of contact that was added.

firstnamestring

First name of contact added.

lastnamestring

Last name of contact added.

created_atstring

Date and time contact was added. Returned in ISO8601 format (YYYY-MM-DD HH:MM:SS) in UTC Timezone.

statusstring

Status of contact. This is always set to active with this request.

fieldsobject

Values assigned to custom fields.

Changes

No recorded changes to this operation across all 2 revisions of this API.