Update

patch

https://api.certify.one/api/v2/issuer-api/recipients/{uuid_or_email}

Update a recipient. At least one of is_organization, name or email
is required.

This is also the endpoint that changes a recipient e-mail address.
Put the address they have today in the uuid_or_email path parameter and
the new one in the email body field.

Every badge embeds a hash of the recipient e-mail, and a certificate or
badge design may print the address, so a changed address invalidates the
recipient's baked files. All of the credentials that recipient holds
with your organization are therefore reprocessed — badges and certificates
alike, with no way to opt out. credentials_reprocessing in the response
tells you how many were queued. The rebuilds run in the background; the
response returns before they finish.

The recipient receives exactly one message about the change, at the new
address, not one message per credential. Nothing is sent to the previous
address.

After a successful change, issuing to the previous address creates a
second, separate recipient and consumes a credit. Use the new address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid_or_email

string

required

you can use recipient uuid or recipient email
when changing an e-mail address, this is the address the recipient has
today; the new one goes in the request body

Body Params

is_organization

boolean

optional
accepted input are true, false, 1, 0, "1", "0"
decides how name is read: true stores it as the
organization name, false splits it into first and last name

name

string

length ≥ 2

optional
the new name for this recipient — send it here to rename them
send the full name as one string; it is split into first and
last name
when is_organization is true this is the organization
name instead
the new name is copied onto the recipient's issued credentials
unless you send update_credentials: false

string

optional
the new e-mail address for this recipient — send it here to
change their address, and put the address they have today in the
uuid_or_email path parameter
the domain must resolve (a MX or A record is required)
reprocesses every credential this recipient holds with you
cannot be combined with update_credentials: false

update_credentials

boolean

Defaults to true

optional
default is true
update all issued credentials of the recipient (badges,
certificates and the blockchain registration) to reflect
the new name/organization
only applies to name and is_organization; sending
false together with email is rejected with 422

Responses

`error` is `Unauthenticated` when no token
is sent and `Invalid Issuer Key` when it matches no account.

Update

`error` is `Unauthenticated` when no token
is sent and `Invalid Issuer Key` when it matches no account.

`message` says what was not found, for example
`issued credential not found`, `credential not found` or `recipient not found`.

`Retry-After` header before trying again.

200OK

401Missing or invalid access token. error is Unauthenticated when no token is sent and Invalid Issuer Key when it matches no account.

404Not found in your account. message says what was not found, for example issued credential not found, credential not found or recipient not found.

429Too many requests (60 per minute per token by default). Wait the number of seconds in the Retry-After header before trying again.

`error` is `Unauthenticated` when no token
is sent and `Invalid Issuer Key` when it matches no account.

`message` says what was not found, for example
`issued credential not found`, `credential not found` or `recipient not found`.

`Retry-After` header before trying again.