Skip to main content

PUT /profiles/:recipient_id

When using PUT, be sure to include all the key-value pairs required by the recipient's profile. Any key-value pairs that exist in the profile but fail to be included in the PUT request will be removed from the profile. Remember, a PUT update is a full replacement of the data. For partial updates, use the PATCH /profiles/{recipient_id} request.

More Examples

The following types of requests will clear out the properties of the Profile:

JSON
// Empty Profile Object
{
"profile": {}
}

The above will result with:

200
{
"status": "SUCCESS"
}

The Profile will now be:

JSON
{
"profile: {}
}

URL: https://api.courier.com/profiles/:recipient_id

Method: PUT

Path Parameters

recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.

Body Parameters

profileobject
+ Show Properties

Responses

status: 200 OK

statusstring

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.

Request Example

curl --request PUT \
--url https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"profile": {
"email": "user@example.com",
"phone_number": "555-555-5555"
}
}
'

Responses Example

{
"status": "SUCCESS"
}
{
"message": "Error Message",
"type": "invalid_request_error"
}