Company Identifiers
Update Company Identifier
Change the scheme or value of an identifier.
PUT
Change the scheme or value of an identifier. The old address is unregistered from the SMP and the new one registered in its place, so anything routed to the old address stops arriving. Senders who stored the old address will have to be told.
AuthorizationBasic <token>
Basic API key authentication. Create a new API key and secret in the Recommand dashboard.
In: header
Path Parameters
companyId*string
The ID of the company to update an identifier for
identifierId*string
The ID of the identifier to update
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/v1/companies/string/identifiers/string" \ -H "Content-Type: application/json" \ -d '{ "scheme": "string", "identifier": "string" }'{ "success": true, "identifier": { "id": "ci_01JQZ8X0M4T7RB6K9V2NDHW3PA", "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA", "scheme": "0208", "identifier": "1012081766", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}