Lists

Create or update recipient by number

post/v4/lists/{listId}/recipients/ByNumber

Request

  • Base URL: https://api.inmobile.com
  • URL: https://api.inmobile.com/v4/lists/{listId}/recipients/ByNumber
  • Auth: one of:
    • HTTP basic
    • API key in query parameter apikey

Path parameters

listIdstring guid required

Id of the list

Query parameters

countryCodestring

Target countryCode

phoneNumberstring

Target phoneNumber

Request body

externalCreatedstring

When the recipient was created in an external system e.g. 2001-02-30T14:50:23Z (UTC time).

fieldsRecipientFieldsCollection

Example request

{
  "externalCreated": "2001-02-30T14:50:23Z",
  "numberInfo": {
    "countryCode": "45",
    "phoneNumber": "12345678"
  }
}

Response

The created or updated recipient

externalCreatedstring

When the recipient was created in an external system e.g. 2001-02-30T14:50:23Z (UTC time).

fieldsRecipientFieldsCollection
idstring guid

The id of the recipient.

listIdstring guid

The id of the list that the recipient belongs to.

createdstring

When the recipient was created e.g. 2001-02-30T14:50:23Z (UTC time).

Example response

{
  "externalCreated": "2001-02-30T14:50:23Z",
  "numberInfo": {
    "countryCode": "45",
    "phoneNumber": "12345678"
  },
  "id": "99e0543f-b059-4127-9b50-c42112f19cc9",
  "listId": "4a5f91d5-3aa4-4419-890e-f7b103406dbf",
  "created": "2001-02-30T14:50:23Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.