Create Bulk Address

post

https://client.api.uat.apps-clowd9.io/v1/schedule/{card_file_schedule_id}/bulk-address

Creation of a Bulk Address which will be provided to your Card Manufacturer in the Card Embossing File for bulk dispatch

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

card_file_schedule_id

string

required

length ≥ 36

Card Manufacturer configuration Id generated by CLOWD9 and associated to Product Identifier

Body Params

Create Bulk Address Request

title

string

length between 0 and 7

Title (person in charge of receiving the bulk cards). Format is Alpha, Numeric and Special Characters

first_name

string

length between 1 and 50

First name ( person in charge of receiving the bulk cards). Format is Alpha only

middle_name

string

length between 0 and 50

Middle name (person in charge of receiving the bulk cards). Format is Alpha only

last_name

string

length between 1 and 50

Last name (person in charge of receiving the bulk cards). Format is Alpha only

phone_number

string

length between 1 and 15

Phone number (person in charge of receiving the bulk cards). International format, no spaces and + is the only Special Character permitted

string

length between 0 and 100

Email (person in charge of receiving the bulk cards). Format is Alpha, Numeric and Special Characters

address_line1

string

length between 1 and 100

Bulk delivery address line 1. Format is Alpha, Numeric and Special Characters

address_line2

string

length between 0 and 100

Bulk delivery address line 2. Format is Alpha, Numeric and Special Characters

address_line3

string

length between 0 and 100

Bulk delivery address line 3. Format is Alpha, Numeric and Special Characters

city

string

length between 1 and 50

Bulk delivery address City. Format is Alpha, Numeric and Special Characters

post_code

string

length between 1 and 9

Bulk delivery address Postal Code. Format is ISO Alpha, Numeric

state_county_or_province

string

length between 0 and 100

Bulk Delivery address State, County or Province. Format is Alpha, Numeric and Special Characters

country_iso

string

length between 3 and 3

Bulk Delivery country code in ISO 3166-3 alpha-3 representation, for example GBR (Great Britain).

bulk_delivery_method

int32

enum

The method for bulk dispatch. Values are 1 (Standard Mail), 2 (Registered Mail), 3 (Direct Delivery - Courier) or 4 (Special)

Allowed:

bulk_ref

string

Clients must agree a bulk reference with the Card Manufacturer. Cards with the same bulk_address_id will be sent together to the bulk address. Format is Alpha, Numeric and Special Characters, maximum length of 36

Responses

200Request Successful

400Bad request. Please review data provided

401When access token is not provided, incorrect, or expired

403When access token provided does not have access to a resource

defaultAn unexpected error response