Create or update customer

post

https://api.getblueshift.com/api/v1/customers

Use this endpoint to create a new customer or update an existing customer.

Body Params

Create customer and update customer attributes

string

Specify the email ID of the customer that you want to create or whose details you want to update. Ensure that the email that you provide in this field does not contain more than 64 characters.

customer_id

string

Specify the customer ID of the customer that you want to create or whose details you want to update.

phone_number

string

Specify the phone number of the customer that you want to create or whose details you want to update. Ensure that it includes the country code, starts with a +, follows the E.164 standard, does not start with a 0, and contains 6 to 14 characters.

subscription_groups

array of objects

Specify the user's subscription preferences.

subscription_groups

firstname

string

Specify the firstname of the customer that you want to create or whose details you want to update.

lastname

string

Specify the lastname of the customer that you want to create or whose details you want to update.

gender

string

Specify the gender (if required) of the customer that you want to create or whose details you want to update.

Responses

400

Bad request - The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

404

Resource not found - Can happen due to resource conflicts. Re-try with exponential backoff. Contact us on [email protected] if the issue persists.

409

Conflict error, please retry - The request could not be completed due to a conflict with the current state of the target resource, re-try with exponential backoff.

413

You can upload maximum 50 users in one api call - The server is refusing to process a request because the request payload is larger than the server is willing or able to process.

429

Rate limit exceeded - Too many requests. Contact us on [email protected] for recommended throughput.

500

Internal Server Error - Please contact blueshift for more information.

502

Service unavailable, please retry - Bad Gateway, re-try with exponential backoff.

503

Service unavailable, please retry - Service Unavailable, re-try with exponential backoff.

504

Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff.

200OK

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

422Unprocessable Entity - The request was well-formed but contains semantic errors.