ITiterable
users

Merge users

Merge two users.<br/><br/>In the request body, specify <code>sourceEmail</code> or <code>sourceUserId</code> (but not both), and <code>destinationEmail</code> or <code>destinationUserId</code> (but not both).<br/><br/>Returns an error if source user does not exist in Iterable. Will update source user if destination user is not found.<br/><br/><b>Rate limit</b>: 50 requests/second, per API key.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/users/merge

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

destinationEmailstring

An email address that identifies a user profile in Iterable. Provide a <code>destinationEmail</code> or a <code>destinationUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

destinationUserIdstring

A user ID that identifies a user profile in Iterable. Provide a <code>destinationEmail</code> or a <code>destinationUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

sourceEmailstring

An email address that identifies a user profile in Iterable. Provide a <code>sourceEmail</code> or a <code>sourceUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

sourceUserIdstring

A user ID that identifies a user profile in Iterable. Provide a <code>sourceEmail</code> or a <code>sourceUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

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