Create Identifier

post

{protocol}://{server}/api/journey/v1beta/accounts/{accountId}/identifiers

This API requires the Account Administrator role.

Creates a new identifier that can then be used to uniquely identify a Customer's Journey.

This will instruct Customer Journey to collect and store identifier values that match the configured name on Customer Journeys that contain it. Unless configured to, Customer Journey will not collect identifiers for names it does not recognise.

Identifiers can be classified as WEAK, STRONG, or VERY STRONG. For example, a phone number is considered a WEAK identifier while an email is considered a STRONG identifier.

The name of the identifier must be unique for the Account, attempts to create duplicate identifiers will be rejected. A maximum of 1000 identifiers can be configured for an Account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Create Identifier

Captures the criteria with which we identify a customer

displayName

string

length between 3 and 50

A unique human readable name for an identifier, for example 'Phone Numbers'.

name

string

required

length between 3 and 50

^[a-zA-Z0-9_\.]+$

The name of the identifier, for example 'phoneNumbers'. This is how the identifier is represented in the engagement and the name it will be validated against.

identifierStrength

string

enum

required

deprecated

This field is deprecated and will be removed in a future release.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Bad Request. accountId must be exactly 6 characters name must not be empty displayName must not be empty identifierStrength must be WEAK, STRONG, or VERY STRONG identifier 'NAME' already exists for account 'ACCOUNT_NAME'

401Unauthorized

403Forbidden

500Internal Server Error