Update Identifier

put

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

This API requires the Account Administrator role.

Updates an existing identifier.

The name of the identifier must be unique for the Account, attempts to create duplicate identifiers will be rejected.

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.

identifierId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the identifier.

Body Params

Update 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 identifierId must exist for the account 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

404Not Found

500Internal Server Error