Register External Profile

POST/organizations/{organizationId}/customers/external-profile

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Register External Profile action (under Shopper Customers).
Fill in the fields below, then reference the result from later steps as {{registerExternalProfile.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Request body

Enter the body as JSON in the step's Body field.

authenticationProviderIdstringrequired

The authentication Provider Id

emailstring

The Email of the customer.

externalIdstringrequired

The ID of the customer.

firstNamestring

The First Name of the customer.

lastNamestring

The Last Name of the customer.

json

{
  "authenticationProviderId": "Google",
  "externalId": "jsmith@gmail.com",
  "email": "s@gmail.com",
  "firstName": "John",
  "lastName": "Smith"
}

Response

Returns 200 with an object. Read it in later steps with {{registerExternalProfile.response.data.<field>}}.

customerIdstring

The Id of the Customer

json

{
  "customerId": "1234"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?