Bulk Create/Update Subscribers
Learn how to use the bulk subscriber endpoints, useful for large scale subscriber updates.
Last updated
Was this helpful?
Jump to...Create Free API Account
Learn how to use the bulk subscriber endpoints, useful for large scale subscriber updates.
Last updated
Was this helpful?
When creating or updating many subscribers at one time with the and endpoints you can quickly exhaust the available . The and endpoints are recommended for handling large subscriber changes via the API, this can save on both request round trip time and overall API call volume.
This endpoint is used to create (or update and create) many subscriber accounts in one request.
CreateOnly ParameterIf set to true the createOnly path parameter indicates the only action should be to create new subscribers and will not update records of existing subscribers. If set to false then both creating or updating (if the subscriber exists) actions will be performed.
Records of subscribers should be in an array.
Required Fields for new subscribers: email or number
This endpoint is used to update many subscriber accounts in one request. The number field is used to identify the subscriber record to be updated , if no number is provided then email will be used an identifier. One of these fields must be provided to identify the subscriber record to be updated.
Records of subscribers should be in an array.
This endpoint will accept a maximum of 1,000 records in a single request.
This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests every 15 seconds
BulkUpdateSubscribers.RequestRecord
BulkUpdateSubscribers.RequestRecord
BulkUpdateSubscribers.RequestWithId
BulkUpdateSubscribers.RequestWithPhoneNumber
BulkUpdateSubscribers.RequestWithEmail
This endpoint will accept a maximum of 1,000 records in a single request. Records of subscribers should be in an array. The createOnly field indicates if the action is creating new subscribers only (doesn't accept records of existing subscribers) or the action is creating or updating (accept records of existing subscribers and update info according to the records).
This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests every 15 seconds
firstName
string
First name of the subscriber.
lastName
string
Last name of the subscriber.
number
number
Phone number of the subscriber.
email
string
Email address of the subscriber.
e164Number
string
E.164 international telephone number of the subscriber. If supplied, will be used over number .
E.164 Format:
[+] [country code] [subscriber number including area code] (max. 15 digits)
groupIds
number[]
List of group ids of the groups the subscriber belongs to.
subscriberFields
dictionary: subscriberFieldIds:string as the keys and data: string corresponding values
A dictionary of key value pairs of additional for the subscriber.
Example:
firstName
string
First name of the subscriber.
lastName
string
Last name of the subscriber.
number(required if no email)
number
Phone number of the subscriber.
email (required if no number)
string
Email address of the subscriber.
e164Number
string
E.164 international telephone number of the subscriber. If supplied, will be used over number .
E.164 Format:
[+] [country code] [subscriber number including area code] (max. 15 digits)
groupIds
number[]
List of group ids of the groups the subscriber belongs to.
subscriberFields
dictionary: subscriberFieldIds:string as the keys and data: string corresponding values
A dictionary of key value pairs of additional for the subscriber.
Example: