Skip to main content
PATCH
/
me
/
profile
Update my profile
curl --request PATCH \
  --url https://api.guile.app/me/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "givenName": "<string>",
  "surname": "<string>",
  "preferredName": "<string>"
}
'
{
  "givenName": "<string>",
  "surname": "<string>",
  "id": "<string>",
  "email": "jsmith@example.com",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "preferredName": "<string>",
  "phoneNumber": "<string>",
  "profileImageUrl": "<string>"
}

Body

application/merge-patch+json

Representation used to patch a customer profile using the JSON Merge Patch format and processing rules.

​
givenName
string<text> | null

The given name of the customer.

Required string length: 1 - 55
​
surname
string<text> | null

The surname of the customer.

Required string length: 1 - 55
​
preferredName
string<text> | null

The preferred name of the customer.

Maximum string length: 55

Response

Ok. The operation succeeded.

A representation of a customer profile.

​
givenName
string<text>
required

The given name of the customer.

Required string length: 1 - 55
​
surname
string<text>
required

The surname of the customer.

Required string length: 1 - 55
​
id
string
required

The unique identifier of the customer profile.

​
email
string<email>
required

The customer's email address.

Required string length: 6 - 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
​
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
preferredName
string<text>

The preferred name of the customer.

Maximum string length: 55
​
phoneNumber
string<phone>

The customer's phone number.

Required string length: 6 - 20
Pattern: ^\+?[0-9]{1,3}?[ -]?\(?[0-9]{1,4}?\)?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,9}$
​
profileImageUrl
string<uri>

A URL to the customer's profile image.

Maximum string length: 255